<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">
	<title>Cookie Class - Fuel Documentation</title>
	<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
	<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
	<script type="text/javascript" src="../assets/js/nav.js"></script>
	<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
	<script type="text/javascript">
		$(function() {
			show_nav('classes', '../');
		});
		hljs.tabReplace = '    ';
		hljs.initHighlightingOnLoad();
	</script>
</head>
<body>

	<header>
		<h1>FUEL Documentation</h1>
	</header>

	<div id="main-nav"></div>

	<section id="content">
		<h2>Cookie Class</h2>

		<p>The cookie class allows you to get, set and delete cookies.</p>

		<p>The cookie class defines the following public variables that you can access:</p>
		<table class="method">
			<tbody>
				<tr>
					<th>Variable</th>
					<th>Static</th>
					<th>Type</th>
					<th>Default</th>
					<th class="description">Description</th>
				</tr>
				<tr>
					<th><kbd>$expiration</kbd></th>
					<td>Yes</td>
					<td>integer</td>
					<td><pre class="php"><code>0</code></pre></td>
					<td>Number of seconds before the cookie expires. This value will be used when $expiration is not specified when you call the set() method.</td>
				</tr>
				<tr>
					<th><kbd>$path</kbd></th>
					<td>Yes</td>
					<td>string</td>
					<td><pre class="php"><code>'/'</code></pre></td>
					<td>Restrict the path that the cookie is available to. This value will be used when $path is not specified when you call the set() method.</td>
				</tr>
				<tr>
					<th><kbd>$domain</kbd></th>
					<td>Yes</td>
					<td>string</td>
					<td><pre class="php"><code>null</code></pre></td>
					<td>Restrict the domain that the cookie is available to. This value will be used when $domain is not specified when you call the set() method.</td>
				</tr>
				<tr>
					<th><kbd>$secure</kbd></th>
					<td>Yes</td>
					<td>boolean</td>
					<td><pre class="php"><code>false</code></pre></td>
					<td>Set to true if you only want to transmit cookies over secure connections.</td>
				</tr>
				<tr>
					<th><kbd>$httponly</kbd></th>
					<td>Yes</td>
					<td>boolean</td>
					<td><pre class="php"><code>false</code></pre></td>
					<td>Allow only transmit of cookies over HTTP, disabling Javascript access.</td>
				</tr>
			</tbody>
		</table>

		<article>
			<h4>get($name, $default = null)</h4>
			<p>The <strong>get</strong> method allows you to read a $_COOKIE variable.</p>
			<table class="method">
				<tbody>
				<tr>
					<th class="legend">Static</th>
					<td>Yes</td>
				</tr>
				<tr>
					<th>Parameters</th>
					<td>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$name</kbd></th>
								<td><i>Required</i></td>
								<td>The key in the $_COOKIE array.</td>
							</tr>
							<tr>
								<th><kbd>$default</kbd></th>
								<td><pre class="php"><code>null</code></pre></td>
								<td>What value should be returned if the array item is not found?</td>
							</tr>
						</table>
					</td>
				</tr>
				<tr>
					<th>Returns</th>
					<td>mixed</td>
				</tr>
				<tr>
					<th>Example</th>
					<td>
						<pre class="php"><code>$theme = Cookie::get('theme', 'blue');</code></pre>
					</td>
				</tr>
				</tbody>
			</table>
		</article>

		<article>
			<h4>set($name, $value, $expiration = null, $path = null, $domain = null)</h4>
			<p>The <strong>set</strong> method allows you to create a cookie.</p>
			<table class="method">
				<tbody>
				<tr>
					<th class="legend">Static</th>
					<td>Yes</td>
				</tr>
				<tr>
					<th>Parameters</th>
					<td>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$name</kbd></th>
								<td><i>Required</i></td>
								<td>The key in the $_COOKIE array.</td>
							</tr>
							<tr>
								<th><kbd>$value</kbd></th>
								<td><i>Required</i></td>
								<td>The value of the cookie.</td>
							</tr>
							<tr>
								<th><kbd>$expiration</kbd></th>
								<td><pre class="php"><code>null</code></pre></td>
								<td>Number of seconds the cookie should last for.</td>
							</tr>
							<tr>
								<th><kbd>$path</kbd></th>
								<td><pre class="php"><code>null</code></pre></td>
								<td>The path on the server in which the cookie will be available on.</td>
							</tr>
							<tr>
								<th><kbd>$domain</kbd></th>
								<td><pre class="php"><code>null</code></pre></td>
								<td>The domain that the cookie is available to.</td>
							</tr>
						</table>
					</td>
				</tr>
				<tr>
					<th>Returns</th>
					<td>boolean</td>
				</tr>
				<tr>
					<th>Example</th>
					<td>
						<pre class="php"><code>Cookie::set('theme', 'blue', 60 * 60 * 24);</code></pre>
					</td>
				</tr>
				</tbody>
			</table>
		</article>

		<article>
			<h4>delete($name)</h4>
			<p>The <strong>delete</strong> delete a parameter from the $_COOKIE array.</p>
			<table class="method">
				<tbody>
				<tr>
					<th class="legend">Static</th>
					<td>Yes</td>
				</tr>
				<tr>
					<th>Parameters</th>
					<td>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th class="description">Description</th>
							</tr>
							<tr>
								<th><kbd>$name</kbd></th>
								<td><i>Required</i></td>
								<td>Remove a cookie item.</td>
							</tr>
						</table>
					</td>
				</tr>
				<tr>
					<th>Returns</th>
					<td>void</td>
				</tr>
				<tr>
					<th>Example</th>
					<td>
						<pre class="php"><code>Cookie::delete('theme')</code></pre>
					</td>
				</tr>
				</tbody>
			</table>
		</article>

	</section>

	<section id="footer">
		<p>
			<a href="http://fuelphp.com">Fuel PHP</a> is released under the MIT license.<br />
			&copy; 2010 - 2011 Fuel Development Team
		</p>
	</section>

</body>
</html>
